home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / bbs / inetshell21.lha / ReadMe.Install < prev    next >
Encoding:
Text File  |  1995-01-05  |  12.2 KB  |  324 lines
  1.                    INetShell V2.1a ©1994 TKA Services
  2.                         Written by Paul Leclair
  3.  
  4.   
  5.   Have you ever wanted to get an easy-to-use shell interface between
  6. CNet BBS and AmiTCP (or other sana2-complient software)?  I did.  Since
  7. we put up AmiTCP (a great program!) on our BBS, we had to find an easy
  8. way for our users to access the Telnet/FTP/etc clients.  We've tried a
  9. couple of different packages, but either the programs would not do what
  10. we wanted them to do, or they were buggy and there was not enough 
  11. programming support from the creators.  Therefore, this project was 
  12. conceived.
  13.  
  14.   I wanted something that my users, especially those who don't have a
  15. clue about Internet and the clients, could go into the shell program
  16. and travel the Internet easily.  So I started working on INet.  The
  17. earlier beta-versions were very functional, but I wanted MORE than
  18. functional.  I wanted something that was also nice to look at.  So I 
  19. tried to come up with something that was not only easy, but also very
  20. asthetically pleasing.  
  21.  
  22.   INetShell is probably the easiest package available for CNet (that
  23. I'm aware of) for doing everything.  The users will be able to Telnet
  24. to sites off a pre-defined menu, they can enter a manual Telnet which
  25. they can enter the site/port number.  It also has the ability to allow
  26. users to add notebook/phonebook entries (registered version only) to
  27. which they can call up during a visit to the Telnet area.  FTP and
  28. Finger options also have user-definable database files...no more need
  29. for thousands of little post-it notes scattered all around your 
  30. computer desk.  :-)
  31.  
  32.    I also wanted to make it idiot-proof and lazy-proof.  So, I decided
  33. to make all of the options and commands hot-keyed.  The less keypresses
  34. that someone has to make, makes it that much faster to get around.
  35. I also added a directory maintenance utility (built-in) which is also
  36. hot-keyed and does all of the functions you could ever wish for in
  37. a DirMaint utility for manipulating files that you FTP'd.  And the
  38. HELP section was set up to be based on the CNet style HELP function so
  39. that it would be easy to use and very informative.
  40.  
  41.    This project has taken about 6 weeks of programming (my first time
  42. at sitting down and writing an ARexx program of this size) and I was
  43. very pleased with the end result.  I hope you will be also.
  44.  
  45.  
  46. Installation:
  47.  
  48. o  Unarchive the INetShell archive to an empty directory
  49.  
  50. o  Make a directory in PFILES: called "InetShell"
  51.  
  52. o  Move the files in the "c" directory to your C: directory assign
  53.    
  54.    : RPSTART - program to install the Rexx Plus environment
  55.    : RPHI    - the Rexx Plus "halt" command (stops rexx programs
  56.                from running/halts execution)
  57.  
  58.  
  59. o  Edit your S:user-startup file and add "RPSTART" on a new line
  60.    so that Rexx Plus's environment can be loaded.  (Only do this if
  61.    you don't have Rexx Plus running on your machine already)
  62.  
  63. o  Move the libs/rexxplslib.library to libs:
  64.  
  65. o  Copy the remainder of the contents of the archive into 
  66.    Pfiles:InetShell/
  67.  
  68. o  If you have been running another kind of interface program or
  69.    have had users using FTP and have previously set up the .netrc
  70.    file(s), they must be all deleted.  Usually, they will reside
  71.    in "Mail:users/<dir>".  You can delete them all by doing the
  72.    following command:
  73.  
  74.               Delete mail:users/#?/.netrc
  75.  
  76. o  Run the RPStart program (to get RexxPlus activated) - it should
  77.    be located in your C: directory if you moved it there in the
  78.    step above.  You should see a message "RPStart...bla bla, installed"
  79.    If you have Rexx Plus's environment already installed, you can 
  80.    skip this step.
  81.  
  82. o  Run the arexx program called INetMaint.  The program is self-explanitory.
  83.  
  84. o  Set up a directory to store the user's profiles/FTP Files (this directory
  85.    must match the name used in the INetConfig entry)
  86.    (ie. MAKEDIR <dirname>)
  87.  
  88.    Suggestion:  use a drive that has a lot of storage because
  89.                 this is where all FTP files end up when a user
  90.                 does an FTP.
  91.  
  92.                 It is HIGHLY suggested that you do NOT set up
  93.                 the directory to merge with "mail:users/" due
  94.                 to users having the ability to download from
  95.                 this directory area.
  96.  
  97. o  Edit your cnet:bbsmenu file(s) and add the following command
  98.    to section "3; Main Prompt"
  99.      
  100.      NET        |{#0PFILES:INetShell/INet}
  101.                  ^
  102.               Control-Q
  103.  
  104.    (INet can be shared over different ports)
  105.  
  106. o  Save bbsmenu file(s) and reload your BBSTEXT/MENU files from the
  107.    CNet Control panel.
  108.  
  109. o  IMPORTANT:  Be sure that the pure bit on the main INet file is set.
  110.    (do a "List pfiles:inetshell/inet" and see if the "p" bit is set.
  111.    if it isn't, do a "protect pfiles:inetshell/inet +p")
  112.  
  113. o  The main INet file is pure and can be made resident to save memory
  114.    and increased speed for loading.
  115.    To make resident, do:  
  116.      "resident pfiles:inetshell/inet pfiles:inetshell/inet pure add"
  117.    (you can add this in your CNet startup script)
  118.  
  119. o  Add an Event entry in Cnet's CONFIG for INetMaint.  You can set
  120.    this to run once a week if you like.  It only checks to see if
  121.    there is a purged bbs user who still has an INet account.  If it
  122.    is there, it will purge the INet directory and info for that
  123.    user.  This is an Arexx program.
  124.  
  125. o  Logon and type "NET" from your main prompt and away you go. 
  126.  
  127.  
  128. ======================================================================
  129.  
  130.  
  131.  *** INSTRUCTIONS ON HOW TO EDIT DATA FILES ***
  132.  
  133.  There are 10 types of config files that the shell uses.  The files are
  134. located in PFILES:INetShell/config/
  135.  
  136.         Inet  -  main program configuration file
  137.   TelnetMenu  -  main list of telnet sites (menu) (registered only)
  138.      Telnet#  -  actual telnet sites              (registered only)
  139.      FTPMenu  -  main list of ftp sites (menu)    (registered only)
  140.         FTP#  -  actual ftp sites                 (registered only)
  141.   ArchieServ  -  list of Archie servers
  142.    IRCServer  -  list of IRC servers
  143.  newuser.txt  -  displayed for new users (all users)
  144. newuser1.txt  -  display only if sysops allow users to choose UUCP ID
  145.         MOTD  -  entry screen (supplied by Piper of eyesoftime.com)
  146.  
  147. -----------------------------------------------------------------------
  148. TelnetMenu:  (only used in the registered version of INetShell)
  149.  
  150.  TelnetMenu is the primary menu that users see when they first enter
  151. the Telnet command off the main menu of INetShell.  This is just a 
  152. list of available sub-menus that the user can enter.  There is no limit
  153. to how many sub-menus you can create.
  154.  
  155.  The format of TelnetMenu is:
  156.  
  157. 2
  158. Menu Item 1
  159. Menu Item 2
  160.  
  161. Line1: the total amount of entries in the file (excluding line 1)
  162. Line2: name of directory
  163. Line3: name of directory
  164. etc
  165.  
  166.  See the example that is packaged with INetShell.
  167.  
  168. -----------------------------------------------------------------------
  169. FTPMenu:  (Only used in the registered version of INetShell)
  170.  
  171.  FTPMenu is the primary menu that users see when they first enter the
  172. FTP command off the main menu of INetShell.  The data format is the
  173. same as TelnetMenu.
  174.  
  175. -----------------------------------------------------------------------
  176. IRCServer:
  177.  
  178.  This is a list of IRC Servers that you can reach.  The data file format
  179. is set up like so:
  180.  
  181. 1
  182. IRC Server (US)
  183. irc.pitt.edu
  184.  
  185.  
  186. Line1: number of total servers listed
  187. Line2: Name given for the server (the name that will show up on the
  188.        server listing)
  189. Line3: the actual server domain name or IP#.
  190.  
  191.   See the example IRCServer file in the config directory.
  192.   As with TelnetMenu and FTPMenu, there is no limit to how many
  193.   servers you may add to this list.
  194.  
  195. -----------------------------------------------------------------------
  196. ArchieServ:
  197.  
  198.  This file contains the available Archie servers that your users can
  199. use when doing an Archie file search.
  200.  
  201. The format is:
  202.  
  203. site.name.or.ip
  204. site.name.or.ip
  205. site.name.or.ip
  206. etc
  207. etc
  208.  
  209.  There is a maximum of 8 sites you can have listed.  This may change
  210. in the future if there is a need for a larger list.  Note that this
  211. file format does NOT contain the # of sites at the start.  It only
  212. contains the domain or IP# of the Archie server site.
  213.  
  214. -----------------------------------------------------------------------
  215. Telnet#: (Only used in registered version of INetShell)
  216.  
  217.  The Telnet(number) file(s) contain the actual sites and descriptions
  218. of the Telnet sites.  These files are connected with the TelnetMenu file.
  219.  
  220.  Here is how it works:
  221.  
  222.   If in TelnetMenu, you have 3 entries, you must have 3 Telnet# files
  223.   (Telnet1, Telnet2 & Telnet3).  When the user picks item 1 off the
  224.   main Telnet list, it will load up and display the Telnet1 sub-menu.
  225.  
  226. The format is:
  227.  
  228. 1
  229. The Kobayashi Alternative BBS
  230. tka.com 23
  231. This is a CNet BBS and home of
  232. the INetShell interface program.
  233.  
  234.  
  235. Line1: number of Telnet sites in the file
  236. Line2: the domain.name or IP# and (optional) port number
  237. Line3: description line 1
  238. Line4: description line 2
  239.  
  240.  
  241.  Note, you MUST have 2 description lines before the next entry.  These
  242. can be blank lines if you wish not to have any description listed.  There
  243. is no limit to how many sites you can have listed in these files.
  244.  
  245. -----------------------------------------------------------------------
  246. FTP#: (Only used in registered version of INetShell)
  247.  
  248.  The FTP(number) file(s) contain the actual sites and descriptions
  249. of the FTP sites.  These files are connected with the FTPMenu file.
  250.  
  251.  The format and how it works is the same as the Telnet# files.
  252.  
  253. -----------------------------------------------------------------------
  254. NOTE:
  255.  
  256.    In the unregistered version, the telnet and ftp menus are read from
  257.  the files called "TELNET" and "FTP" in the config/ directory.  These
  258.  files follow the format of TELNET# and FTP# which is listed above.
  259.  
  260.  
  261. =======================================================================
  262.  
  263. What happens when a new user gets into the INetShell:
  264.  
  265.  1.  The program will check to be sure that they have a valid 
  266.      Internet Name (UUCP ID).  If this has never been set, it
  267.      will ask the user to enter a name.
  268.  
  269.  2.  The program will then create the user's FTP storage directory
  270.      in the location you specified in the "INet" config file. 
  271.  
  272.  3.  It will then copy the default "." files from the INetShell/new/
  273.      directory into their FTP storage directory.
  274.  
  275.  4.  It will then create a .netrc with default settings in the
  276.      user's "mail:users/<dir>" area.
  277.  
  278.  5.  Then it will maintain the AmiTCP:db/passwd file (as specified
  279.      in the INet config) and add an entry for their account.
  280.  
  281.  6.  Finally it will let them into the main menu.
  282.  
  283. =======================================================================
  284. BUGS & ERROR REPORTS:
  285.  
  286.   Should the program have a programming error (GOD FORBID!), it will
  287. report it in E-Mail to User ID#1 (usually the sysop).  Please forward
  288. this mail file to me at my Internet address (limahl@tka.com).
  289.  
  290.   Note that the program may and will error out should you run the
  291.   ARexx "halt" (hi) command.  Usually, it will give some kind of
  292.   syntax error.  The next release (1.5) should have this taken care
  293.   of.
  294. =======================================================================
  295. OTHER STUFF:
  296.  
  297.   I would like to thank Mainiac (Dean C. Banks) for helping me figure
  298. out how to get the menuing system working and to keep pushing me to get
  299. this project finished.  
  300.  
  301.   I'd also like to thank my 2 beta-testers for the INet project.  Piper
  302. of Eyes of Time BBS (piper@eyesoftime.com) and Runr of Laserbase
  303. Communications (runr@laserbase.com).  With their bug reports and ideas,
  304. the shell has become quite stable and VERY easy to use for both sysops
  305. and users.  
  306.  
  307.   Also I want to thank Piper for creating the nice entry screen for
  308. INet Shell.  
  309.  
  310.   This project took me about 6 weeks to complete.  Most of the work was
  311. done in the last 2 weeks (12 hour days).  This is also my first attempt
  312. at creating a complex ARexx program so please be kind.  :)
  313.  
  314.   Added in the distribution of the demo of INetShell is a nice little
  315. utility that allows OLMs sent to users online should new Internet
  316. E-Mail be imported from the UUMail: directory.  Note that this program
  317. uses CNETREXX0 and may spit out a number when an olm comes to you on
  318. port 0.  This is a CNETREXX port problem which I will try to have
  319. fixed in a future release of this UUMailScan program.
  320.  
  321.  
  322.   If you have any comments, please E-Mail them to me at the above listed
  323. address.
  324.